#Unity のゲームを #CircleCI を使ってAWSへ自動デプロイしてみた

入井啓太

2023.01.27

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

こんにちは、ゲームソリューショングループの入井です。

以前、CircleCI 上でUnityのゲームを自動ビルドする記事を書きました。

この記事ではゲームのビルドを行うところまでしか取り扱っていませんでしたが、実際のゲーム開発ではこのままデプロイも自動化したくなると思います。

今回は、UnityでビルドしたWebGLゲームデータをAWS環境にデプロイする一連の流れについて、CircleCIで自動化する方法を書いていきます。

なお、上記の記事と同じリポジトリを今回も使用しており、以下の文章もそれを前提に記載しています。

全体的な構成

今回構築したビルドからデプロイまでの流れとしては以下のような形です。

GitHubのリポジトリへのコミットをトリガーにCircleCIのパイプライン実行開始
CircleCI上でGameCIのUnity環境を使ってゲームビルド
ゲームのビルド結果をAWSのS3バケットへデプロイ
ゲームのユーザはCloudFrontを経由してS3バケット内のゲームをプレイ

事前にAWSの環境を用意しておく

上記の通り、デプロイ先であるAWSの構成としてはCloudFrontで外部からのリクエストを受け、S3バケット内のWebGLゲームデータをクライアントへ返す形になっています。

この構成が実現できるよう、CircleCIでパイプラインを実行する前にゲームデータを格納するS3バケットと、それと連携するCloudFrontディストリビューションを作成しておきます。

以下の記事で書いたAWSの設定をそのまま使用できます。

CircleCIのConfigファイルを書く

CircleCIでのデプロイを実現するため、対象のゲームのリポジトリ内にある.circleci/config.ymlファイルに以下のように設定を書きます。

version: 2.1

orbs:
  unity: game-ci/unity@1.4.0
  aws-s3: circleci/aws-s3@3.1

jobs:
  build:
    executor:
      name: "unity/ubuntu"
      target_platform: "webgl"
      editor_version: "2021.3.9f1"
      resource_class: "large"
    steps:
      - checkout
      - unity/prepare-env:
          unity-license-var-name: "UNITY_ENCODED_LICENSE"
          unity-username-var-name: "UNITY_USERNAME"
          unity-password-var-name: "UNITY_PASSWORD"
      - unity/build:
          project-path: "src"
          build-target: "WebGL"
          compress: false
          store-artifacts: false
      - persist_to_workspace:
          root: .
          paths:
            - "src/Builds/WebGL"

  deploy:
    docker:
      - image: cimg/aws:2022.11
    steps:
      - checkout
      - attach_workspace:
          at: .
      - aws-s3/sync:
          aws-region: "AWS_REGION"
          role-arn: $AWS_ROLE_ARN
          from: "src/Builds/WebGL/WebGL"
          to: 's3://bucket-name'

workflows:
  build-unity-project:
    jobs:
      - build:
          context: unity
      - deploy:
          requires: 
            - build
          context: aws

パイプライン全体の流れとしては、以下のような形です。